<?php

/**
 * Common code base to all parsers
 *
 * PHP version 5
 *
 * LICENSE:
 *
 * Copyright (c) 2008-2009, Philippe Jausions / 11abacus
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of 11abacus nor the names of its contributors may
 *     be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Structures
 * @package   Structures_Location
 * @author    Philippe Jausions <Philippe.Jausions@11abacus.com>
 * @copyright 2008-2009 by Philippe Jausions / 11abacus
 * @license   http://www.opensource.net/licenses/bsd-license.php New BSD
 */

/**
 * Required dependencies
 */
require_once 'Structures/Location.php';
require_once 'Structures/Location/ParserInterface.php';

/**
 * Common code base to all parsers
 * 
 * @category Structures
 * @package  Structures_Location
 * @author   Philippe Jausions <Philippe.Jausions@11abacus.com>
 */
abstract class Structures_Location_Parser implements Structures_Location_ParserInterface
{
    /**
     * Some often-used regular expressions for PO Box parsing
     * 
     * @var array language code => regular expression
     */
    protected $regexPoBox = array(
        'en' => 'p((o|0)st)?\s*[-.,\/]?\s*(o|0)(ff(ice)?)?\s*[-.,\/]?\s*b(o|0)x?\s*[-.\/]?\s*',
        'fr' => 'b((o|0)(i|î|I)te)?\s*[-.\/]?\s*p((o|0)stale?)?\s*[-.\/]?\s*',
        'it' => 'c(ase(lla)?)?\s*[-.\/]?\s*p((o|0)stale?)?\s*[-.\/]?\s*',
        'es' => '(apd(o|0)\s*[-.\/]?|apartad(o|0)(\s*de\s*c(o|0)rre(o|0)s)',
    );
    
    /**
     * A regular expression snippet for prefixing numbers: No, #, N°, /, etc...
     *
     * @var string
     */
    protected $regexNumber = '#|,|Nbr|No|N°|Nº|\/|:|\.|-';

    /**
     * Checks the instance or class name passed is for a 
     * Structures_LocationInterface
     * 
     * @param string|Structures_LocationInterface $classObject Class name or instance to fill information with
     * 
     * @return Structures_LocationInterface $location instance
     */
    protected function checkInstance($classObject = 'Structures_Location')
    {
        if (!is_object($classObject)) {
            $instance = new $classObject();
        } else {
            $instance = $classObject;
        }
        if (!($instance instanceof Structures_LocationInterface)) {
            throw new Structures_Location_Exception_Invalid('Not a Structures_LocationInterface');
        }
        return $instance;
    }
}

?>